Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Workspace] Fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper #6669

Merged
merged 6 commits into from
Apr 29, 2024
Merged

[Workspace] Fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper #6669

merged 6 commits into from
Apr 29, 2024

Conversation

SuZhou-Joe
Copy link
Member

@SuZhou-Joe SuZhou-Joe commented Apr 29, 2024 •
edited
Loading

Description

A new wrapper, workspace_ui_settings, has been introduced by workspace plugin. When a user attempts to access an invalid workspace, OSD will display plain JSON instead of a user-friendly web page. This PR primarily addresses the issue by adding a try catch wrapper to the client.get method.

Issues Resolved

Screenshot

Before fix

image

After fix

image

As well as an error log in OSD:

image

Testing the changes

  • Use the branch to bootstrap and enable workspace feature flag
  • Type an invalid url like http://localhost:5601/w/123/app/workspace_overview
  • An error page with error message saying: Saved object [workspace/123] not found should be found.

Changelog

  • fix: optimization on handling invalid workspace id in workspace_ui_settings wrapper

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@SuZhou-Joe
fix: invalid workspace id
74beb5c 
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
@SuZhou-Joe SuZhou-Joe added bug Something isn't working workspace v2.14.0 labels Apr 29, 2024
@codecov Codecov
Copy link

codecov bot commented Apr 29, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 67.79%. Comparing base (460428c) to head (39d74fb).
Report is 468 commits behind head on main.

Files with missing lines Patch % Lines
...ed_objects/workspace_ui_settings_client_wrapper.ts 85.71% 0 Missing and 1 partial ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #6669   +/-   ##
=======================================
  Coverage   67.79%   67.79%           
=======================================
  Files        3413     3413           
  Lines       66755    66760    +5     
  Branches    10861    10863    +2     
=======================================
+ Hits        45254    45258    +4     
  Misses      18857    18857           
- Partials     2644     2645    +1
Flag Coverage Δ
Linux_1 33.19% <87.50%> (+<0.01%) ⬆️
Linux_2 55.63% <ø> (ø)
Linux_3 45.24% <ø> (ø)
Linux_4 34.91% <ø> (ø)
Windows_1 33.21% <87.50%> (+<0.01%) ⬆️
Windows_2 55.59% <ø> (ø)
Windows_3 45.26% <ø> (ø)
Windows_4 34.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

SuZhou-Joe and others added 3 commits April 29, 2024 14:46
@SuZhou-Joe @ruanyl
Update src/plugins/workspace/server/saved_objects/workspace_ui_settin…
e774260 
…gs_client_wrapper.ts

Co-authored-by: Yulong Ruan <ruanyu1@gmail.com>
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
@SuZhou-Joe
feat: update error message
51fa623 
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
@SuZhou-Joe
fix: type error
e15a2cf 
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
wanglam
wanglam reviewed Apr 29, 2024
View reviewed changes
src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts Outdated
configObject.attributes = {
...configObject.attributes,
...(workspaceObject ? workspaceObject.attributes.uiSettings : {}),
};

configObject.attributes = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems the configObject.attributes has already been set above. Why we need to assign it again?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, remove the useless assign.

@SuZhou-Joe
feat: remove useless code
39d74fb 
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
@SuZhou-Joe SuZhou-Joe merged commit 29a09b0 into opensearch-project:main Apr 29, 2024
69 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 29, 2024
@github-actions @opensearch-changeset-bot @ruanyl
[Workspace] Fix: optimization on handling invalid workspace id in wor…
2953968 
…kspace_ui_settings wrapper (#6669)

* fix: invalid workspace id

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* Changeset file for PR #6669 created/updated

* Update src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts

Co-authored-by: Yulong Ruan <ruanyu1@gmail.com>
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: update error message

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* fix: type error

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: remove useless code

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

---------

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Co-authored-by: Yulong Ruan <ruanyu1@gmail.com>
(cherry picked from commit 29a09b0)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 29, 2024
Merged
SuZhou-Joe pushed a commit that referenced this pull request Apr 30, 2024
@opensearch-trigger-bot @github-actions
@opensearch-changeset-bot @ruanyl
[Workspace] Fix: optimization on handling invalid workspace id in wor…
67730a6 
…kspace_ui_settings wrapper (#6669) (#6672)

* fix: invalid workspace id



* Changeset file for PR #6669 created/updated

* Update src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts




* feat: update error message



* fix: type error



* feat: remove useless code



---------




(cherry picked from commit 29a09b0)

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Co-authored-by: Yulong Ruan <ruanyu1@gmail.com>
@Hailong-am Hailong-am mentioned this pull request Apr 30, 2024
Merged
1 task
LDrago27 pushed a commit to LDrago27/OpenSearch-Dashboards that referenced this pull request Jun 3, 2024
@SuZhou-Joe @opensearch-changeset-bot
@ruanyl @LDrago27
[Workspace] Fix: optimization on handling invalid workspace id in wor…
f9fa183 
…kspace_ui_settings wrapper (opensearch-project#6669)

* fix: invalid workspace id

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* Changeset file for PR opensearch-project#6669 created/updated

* Update src/plugins/workspace/server/saved_objects/workspace_ui_settings_client_wrapper.ts

Co-authored-by: Yulong Ruan <ruanyu1@gmail.com>
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: update error message

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* fix: type error

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: remove useless code

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

---------

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Co-authored-by: Yulong Ruan <ruanyu1@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Hailong-am Hailong-am Hailong-am approved these changes

@kavilla kavilla kavilla approved these changes

@wanglam wanglam wanglam approved these changes

@ruanyl ruanyl ruanyl approved these changes

@ananzh ananzh Awaiting requested review from ananzh ananzh is a code owner

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@ashwin-pc ashwin-pc Awaiting requested review from ashwin-pc ashwin-pc is a code owner

@joshuarrrr joshuarrrr Awaiting requested review from joshuarrrr joshuarrrr is a code owner

@abbyhu2000 abbyhu2000 Awaiting requested review from abbyhu2000 abbyhu2000 is a code owner

@zengyan-amazon zengyan-amazon Awaiting requested review from zengyan-amazon zengyan-amazon is a code owner

@zhongnansu zhongnansu Awaiting requested review from zhongnansu zhongnansu is a code owner

@manasvinibs manasvinibs Awaiting requested review from manasvinibs manasvinibs is a code owner

@ZilongX ZilongX Awaiting requested review from ZilongX ZilongX is a code owner

@Flyingliuhub Flyingliuhub Awaiting requested review from Flyingliuhub Flyingliuhub is a code owner

@curq curq Awaiting requested review from curq curq is a code owner

@bandinib-amzn bandinib-amzn Awaiting requested review from bandinib-amzn bandinib-amzn is a code owner

@BionIT BionIT Awaiting requested review from BionIT BionIT is a code owner

@xinruiba xinruiba Awaiting requested review from xinruiba xinruiba is a code owner

Assignees
No one assigned
Labels
backport 2.x bug Something isn't working in-next seasoned-contributor v2.14.0 workspace
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@SuZhou-Joe @ruanyl @wanglam @kavilla @Hailong-am @AMoo-Miki